Skip to content

Update according to Contributors library guidelines #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 13, 2020
Merged

Update according to Contributors library guidelines #53

merged 5 commits into from
Sep 13, 2020

Conversation

JordanMartinez
Copy link
Contributor

This pull request is part of an effort to update and standardize the Contributors libraries according to the Library Guidelines. Specifically, it:

  1. Adjusts the files and repository structure according to the repository structure section of the guidelines, which includes standard pr templates, issue templates, CI in GitHub Actions, automatic stale issue management, ensures the project uses Spago, and so on.
  2. Updates the README and documentation according to the documentation section of the guidelines. This is a first step towards ensuring Contributors libraries have adequate module documentation, READMEs, a docs directory, and tests (even if just usage examples) in a test directory.
  3. Updates labels where relevant to help folks better sift through issues on this library and get started contributing.

This PR is the groundwork for followup efforts to ensure contributor libraries are kept up-to-date, documented, tested, and accessible to users and new contributors.

@thomashoneyman
Copy link
Contributor

@JordanMartinez It looks like some extra files are still in here (the Travis file, the backups directory). Mind removing those?

@JordanMartinez
Copy link
Contributor Author

Done. Sorry, I missed that part in the instructions.

Simulates what would occur if I used `--title "String Parsers"` CLI arg 
when running contrib-updater tool
@thomashoneyman
Copy link
Contributor

Sorry, one last thing! In the .github directory I see:

Screen Shot 2020-09-13 at 11 39 35 AM

and we should remove the issue_template.md file (it's replaced by the ISSUE_TEMPLATE directory), and the contributing.md and pull_request_template.md files (we only need the capitalized CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md files).

Otherwise this is good to go!

@JordanMartinez
Copy link
Contributor Author

Fixed!
I think I reverted my commits and reran the contrib tool. Looks like I forgot to do the git mv step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants